/******************************************************************************
* The MIT License
* Copyright (c) 2003 Novell Inc.  www.novell.com
* 
* Permission is hereby granted, free of charge, to any person obtaining  a copy
* of this software and associated documentation files (the Software), to deal
* in the Software without restriction, including  without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 
* copies of the Software, and to  permit persons to whom the Software is 
* furnished to do so, subject to the following conditions:
* 
* The above copyright notice and this permission notice shall be included in 
* all copies or substantial portions of the Software.
* 
* THE SOFTWARE IS PROVIDED AS IS, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*******************************************************************************/
//
// Novell.Directory.Ldap.Extensions.ListReplicasRequest.cs
//
// Author:
//   Sunil Kumar (Sunilk@novell.com)
//
// (C) 2003 Novell, Inc (http://www.novell.com)
//

using System;
using System.IO;
using Novell.Directory.Ldap.Asn1;
using Novell.Directory.Ldap.Utilclass;

namespace Novell.Directory.Ldap.Extensions
{
    /// <summary>
    ///     Lists all the replicas that reside on the the specified directory server.
    ///     To list replicas, you must create an instance
    ///     of this class and then call the extendedOperation method with this
    ///     object as the required LdapExtendedOperation parameter.
    ///     The listReplicaRequest extension uses the following OID:
    ///     2.16.840.1.113719.1.27.100.19
    ///     The requestValue has the following format:
    ///     requestValue ::=
    ///     serverName  LdapDN
    /// </summary>
    public class ListReplicasRequest : LdapExtendedOperation
    {
        static ListReplicasRequest()
        {
            /*
                * Register the extendedresponse class which is returned by the
                * server in response to a ListReplicasRequest
                */
            LdapExtendedResponse.register(ReplicationConstants.LIST_REPLICAS_RES, typeof(ListReplicasResponse));
        }

        /// <summary>
        ///     Constructs an extended operation object for listing replicas.
        /// </summary>
        /// <param name="serverName">
        ///     The server which contains replicas.
        /// </param>
        /// <exception>
        ///     LdapException A general exception which includes an error
        ///     message and an Ldap error code.
        /// </exception>
        public ListReplicasRequest(string serverName) : base(ReplicationConstants.LIST_REPLICAS_REQ, null)
        {
            try
            {
                if ((object) serverName == null)
                    throw new ArgumentException(ExceptionMessages.PARAM_ERROR);

                var encodedData = new MemoryStream();
                var encoder = new LBEREncoder();

                var asn1_serverName = new Asn1OctetString(serverName);

                asn1_serverName.encode(encoder, encodedData);

                setValue(SupportClass.ToSByteArray(encodedData.ToArray()));
            }
            catch (IOException ioe)
            {
                throw new LdapException(ExceptionMessages.ENCODING_ERROR, LdapException.ENCODING_ERROR, null, ioe);
            }
        }
    }
}